Skip to content

[feat] [WIP] Store augmentation #1192

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 27 commits into from
Closed

[feat] [WIP] Store augmentation #1192

wants to merge 27 commits into from

Conversation

HerringtonDarkholme
Copy link
Member

Fix #994

Based on #1121

Vuex has added $store: Store<any> to Vue instance. This is suboptimal since it doesn't allow users to provide their own store type.

By utilizing TS2.8's conditional type, we can write a PermissiveAny<T> type which allows users to customize interface with any as fall-back. It can provide opt-in type safety for store.

The store type is parameterized by State. By introducing a global RootState interface, we can annotate $store as Store<PermissiveAny<RootState>>. If users don't augment RootState, the $store type is equivalent to Store<any>. On the other hand, if users do augment RootState, the store type will be changed to Store<RootState>.

Effectively, this feature allows users to manual annotate store type, but without breaking existing code.

cc @blake-newman @ktsn

ktsn and others added 27 commits November 6, 2017 12:10
@ktsn
feat: improve helper types to utilize Vue 2.5 types
0768c80
@ktsn
feat(types): [WIP] more strict typed store assets
25775c5
@ktsn
Merge branch 'dev' into feat-improve-typing
21ee399
@ktsn
fix(types): relax map state function type
eee1f3c
@ktsn
test(types): update namespaced helper type test
f94cf70
@ktsn
feat(types): allow to specify assets types on mapXXX helpers
a5c4e26
@ktsn
chore(types): add comments for helpers and utilities types
58d28a5
@ktsn
fix(types): revert renaming Payload to avoid breaking change
0858c6d
@ktsn
feat(helpers): return root helpers if no namespace is provided to cre…
1e27c5e 
…ateNamespacedHelpers
@ktsn
feat(types): add DefineModule utility type
c2068f3
@ktsn
fix(types): allow to omit payload on mapped methods if it is untyped
7abf34f
@ktsn
docs(helpers): improve createNamespacedHelpers description
9564b80
@ktsn
fix(types): expose DefineGetters/Mutations/Actions type
1aa407f
@ktsn
chore: include utils.d.ts for files field
cfb6042
@ktsn
fix(types): make dispatch/commit more type safe in module actions if …
00360b5 
…they are annotated
@ktsn
fix(types): remove default type parameters from StrictDispatch/Commit
9b89ae7
@ktsn
refactor: use undefined type to indicate empty payload instead of null
09475d5
@ktsn
fix(types): fix incorrect type annotation
8e0c60b
@ktsn
fix(types): fix ActionContext type
b14662c
@ktsn
fix(types): remove incorrect overload
b24d744
@ktsn
refactor(types): just use Dispatch/CommitOptions instead of BaseDispa…
8b6a6f9 
…tch/CommitOptions
@ktsn
docs: add typescript docs
9b183f0
@ktsn
docs: fix typo in typescript docs
715eaad
@ktsn
docs: add a note about conditional types
fc1f29b
@ktsn
Merge branch 'dev' into feat-improve-typing
c3626f7
@HerringtonDarkholme
Merge branch 'feat-improve-typing' of github.com:ktsn/vuex into feat-…
2c1c35b 
…improve-typing
@HerringtonDarkholme
feat(type): add RootState for store type customization
1a9f56a 
fix vuejs#994
@HerringtonDarkholme
Copy link
Member Author

HerringtonDarkholme commented Mar 17, 2018 •
edited
Loading

There are some concerns:

  1. should we also apply this approach to ComponentOption? It seems not desirable as Feature: Manually install vuex/types/vue.d.ts #994 (comment)

  2. This augmentation is global. That is, once declared, every $store is typed exactly the same as declaration. This might have unexpected outcome when users have multiple store instantiation. For example, test is not included in this pull request because we have two test examples. One global type prevents us to write two distinct store in one compilation.

  3. Store is now only parameterized by State. If this approach is adopted, should we add more type parameters to store?

@ktsn ktsn added the types Related to typings only label Mar 19, 2018
@ktsn ktsn mentioned this pull request Apr 7, 2018
Closed
@Koc
Copy link

Koc commented Jan 19, 2019

@HerringtonDarkholme have you looked at https://github.com/championswimmer/vuex-module-decorators ? Decorators allows us write store modules as simple classes. It is very useful and less verbose.

@kiaking
Copy link
Member

kiaking commented Apr 21, 2020

Closing this PR since this is technically breaking change, we can't introduce this on Vuex 3. However, the fix will be applied to Vuex 4 via #1717.

@kiaking kiaking closed this Apr 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

types Related to typings only

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Feature: Manually install vuex/types/vue.d.ts

4 participants

@HerringtonDarkholme @Koc @kiaking @ktsn